Account Management Biz Api
GET-billingAccountById(Digital To Aria)
Get
This operation allows retrieve the billing account information.
Request
This section defines all the possible data structures sent by the client when consuming the method.
URI PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA,PR, etc.) identifying the business unit. | Y |
| id | string | Unique identifier of the account | Y |
Security Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
Header
| name | type | description | required |
|---|---|---|---|
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| channelId | string | This is to identify the source (Project). Value : BUS sfdc-b2c | Conditionally Mandatory |
| lob | string | The Line of Business Identifier enum: ["FIXED", "PREPAID", "POSTPAID"] | Conditionally Mandatory |
| targetSystem | string | Use this data type to indicate target system name/id in your request. ["ARIA"] | Conditionally Mandatory |
###Curl
curl --location --request GET 'https://nonprod.esb.cloud.lla.com/dev/account-management-biz/tmf-api/accountManagement/v4/PR/billingAccount/BANx1011-CANx22x2' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92cDD' \
--header 'client_id: abcd' \
--header 'client_secret: 12345' \
--header 'targetSystem: Aria'
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
{
"@type": "BillingAccount",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 147.4
}
}
],
"billStructure": {
"cycleSpecification": {
"paymentDueDateOffset": 0
}
},
"extendedCharacteristics": [
{
"name": "billDate",
"value": "2023-09-20"
},
{
"name": "autoPayDate",
"value": "2023-10-13"
}
],
"relatedParty": [
{
"id": "523367056057",
"@type": "MigratedAccountRef",
"name": "BAN"
}
]
}